<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>The Raxan Framework</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css" media="screen, projection"><![endif]-->
</head>

<body>

    <div class="container c39">

        <p>&nbsp;</p>
        <h1>The Raxan Framework</h1>
        <hr />

        <div class="column panel c8">
            <div class="pb1"></div><div class="pb2"></div><div class="pm1">
                <h5 class="pnl-header">Table of Content</h5>
                <ul class="hlf-pad">
                    <li><a href="index.html">Overview</a></li>
                    <li><a href="getting-started.html">Getting Started</a></li>
                    <li><a href="your-first-page.html">Your First Page</a></li>
                    <li><a href="code-behind.html">Code-Behind Page</a></li>
                    <li><a href="quick-reference-css.html">CSS Framework</a></li>
                    <li class="lightgray"><a href="quick-reference-htmlobject.html">Quick Reference</a></li>
                    <li><a href="../css-examples/index.html">Examples</a></li>
					<li><a href="plugins.html">Rich Plugins</a></li>
                    <li><a href="vision.html">The Vision</a></li>
                    <li><a href="roadmap.html">The Roadmap</a></li>
                    <li><a href="credits.html">Credits/Ackns.</a></li>
                </ul>
            </div><div class="pb2 pb3"></div><div class="pb1 pb4"></div>
        </div>

        <div class="column c29 prepend1">
              <h2>HTML Object Quick Reference</h2>

              <p>The html object is the main Javascript object that contains the methods and properies used
              by the Raxan Framework.</p>

              <table class="border" border="1" cellspacing="0" cellpadding="0" summary="HTML Object Quick Reference">
                <tbody>
                  <tr class="header">
                    <th class="c6" valign="top">Methods/Events</th>
                    <th valign="top">Description</th>
                    <th valign="top">Example</th>
                  </tr>
                  <tr>
                    <td valign="top">version</td>
                    <td valign="top">Return the version number of the framework</td>
                    <td valign="top">alert(html.version);</td>
                  </tr>
                  <tr class="even">
                    <td valign="top">path</td>
                    <td valign="top">Path to framework files. This will be detected by default.</td>
                    <td valign="top">
                      <p>To manually set the library path use:</p>
                      <p>html.path = './raxan-changes';</p>
                    </td>
                  </tr>
                  <tr>
                    <td valign="top">csspath</td>
                    <td valign="top">Path to Raxan sylesheets. This will be detected by default.</td>
                    <td valign="top">
                      <p>To manually set the css path use:</p>
                      <p>html.csspath = './mystyles';</p>
                    </td>
                  </tr>
                  <tr class="even">
                    <td valign="top">pluginpath</td>
                    <td valign="top">Path to Raxan plugins. This will be detected by default.</td>
                    <td valign="top">
                      <p>To manually set the plugins path path use:</p>
                      <p>html.pluginpath = './myplugins';</p>
                    </td>
                  </tr>
                  <tr>
                    <td valign="top">mainScript</td>
                    <td valign="top">Returns the name of the main startup or code-behind script. If multiple
                    startup scripts were specified then this property will return an array.</td>
                    <td valign="top">alert(html.mainScript)</td>
                  </tr>
                  <tr>
                    <td valign="top"><strong>Methods</strong></td>
                    <td valign="top"> </td>
                    <td valign="top"> </td>
                  </tr>
                  <tr class="even">
                    <td valign="top">bind(css,evt,fn)</td>
                    <td valign="top">
                      <p>Bind the event of an html element to a function.</p>
                      <ul>
                        <li>css - Element selector</li>
                        <li>evt - Name of event</li>
                        <li>fn - Callback function</li>
                      </ul>
                    </td>
                    <td valign="top" scope="col">
                      <p>html.bind(&quot;#btnsave&quot;, &quot;click&quot;, function(){<br />
                           alert(&quot;You have clicked me&quot;);<br/>
                      });</p>
                    </td>
                  </tr>
                  <tr>
                    <td valign="top">css(src,extrn)</td>
                    <td valign="top">
                      <p>Dynamically load a stylesheet from the server.</p>
                      <ul>
                        <li>src - Stylesheet URL.</li>
                        <li>extrn -  Set to true when loadig styles that are not located inside styles
                        folder.</li>
                      </ul>
                    </td>
                    <td valign="top">html.include(&quot;master&quot;);<br />
                    html.include(&quot;name-of-theme/theme&quot;);<br />
                    <br />
                    // for other stylesheets<br />
                    html.include("path/to/folder/stylesheet.css", true);<br />
                    <br /></td>
                  </tr>
                  <tr class="even">
                    <td valign="top">include(src,extrn,fn)</td>
                    <td valign="top">
                      <p>Dynamically load a Javascript from the server.</p>
                      <ul>
                        <li>src - Javscript URL.</li>
                        <li>extrn -  Set to true when loadig styles that are not located inside plugins
                        folder.</li>
                        <li>fn - Calback function to receive notification after the file has loaded.</li>
                      </ul>
                    </td>
                    <td valign="top">html.include("myplugin");<br />
                    html.include("namespace/myplugin");<br />
                    html.include("path/to/folder/myscript.js", true);<br />
                    html.include("path/to/folder/myscript.js", true, function(){<br />
                        alert(&quot;File loaded successfully&quot;);<br />
                    });<br />
                    <br /></td>
                  </tr>
                  <tr>
                    <td valign="top">urlparams()</td>
                    <td valign="top">Returns an array containing url parameters passed to the page.</td>
                    <td valign="top">var url = html.urlparams();<br />
                    alert(url['name']);<br />
                    <br /></td>
                  </tr>
                  <tr class="even">
                    <td valign="top">filename()</td>
                    <td valign="top">Returns the web page file<br /></td>
                    <td valign="top">alert(html.filename());<br />
                    <br /></td>
                  </tr>
                  <tr>
                    <td valign="top">post(url, data)</td>
                    <td valign="top">
                      Post data to the server.
                      <ul>
                        <li>url - URL to post data.</li>
                        <li>data - hash array containing data to be sent to the web server.</li>
                      </ul>
                    </td>
                    <td valign="top">var data = {<br />
                       name:&quot;value1&quot;,<br />
                       name2: &quot;value2&quot;<br />
                    }<br />
                    // send data to server<br />
                    html.post(&quot;save.php&quot;,data);<br />
                    <br /></td>
                  </tr>
                  <tr class="even">
                    <td valign="top">log(txt)</td>
                    <td valign="top">Log text to window.console or display in status bar. The window.console
                    is used if Firebug is enabled.<br />
                    <br /></td>
                    <td valign="top"> </td>
                  </tr>
                  <tr>
                    <td valign="top"><strong>Events</strong></td>
                    <td valign="top">&nbsp;</td>
                    <td valign="top">&nbsp;</td>
                  </tr>
                  <tr class="even">
                    <td valign="top">ready(fn)</td>
                    <td valign="top">Bind a function to the ready event. This event is triggered when the DOM
                    has be loaded and can be manipulated.<br />
                    <br /></td>
                    <td valign="top">html.ready(function(){<br />
                        alert(&quot;The DOM is ready&quot;);<br />
                    });<br /></td>
                  </tr>
                  <tr>
                    <td valign="top">load(fn)</td>
                    <td valign="top">Bind a function to the browser's onload event.</td>
                    <td valign="top"> </td>
                  </tr>
                  <tr class="even">
                    <td valign="top">unload(fn)</td>
                    <td valign="top">Bind a function to the browser's unload event.</td>
                    <td valign="top"> </td>
                  </tr>
                  <tr>
                    <td valign="top"> </td>
                    <td valign="top"> </td>
                    <td valign="top"> </td>
                  </tr>
                </tbody>
            </table>

        </div>

        <hr />
        <p class="medium">The Rich Ajax Application Framework. Visit <a href="http://raxanpdi.com">http://raxanpdi.com</a></p>

    </div>

</body>

</html>